home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d20 / zipstr25.arc / ZIPSTER.DOC < prev    next >
Text File  |  1990-02-18  |  11KB  |  295 lines

  1.  
  2.  
  3.            Zipster 2.5 by Bill Hay
  4.  
  5.   A Door to View/Read/Test/Extract Zipfiles
  6.  
  7.               February 18, 1990
  8.  
  9.  
  10.   Table of Contents:
  11.  
  12.      I  -  Files Needed
  13.     II  -  Basic Features of Zipster
  14.    III  -  Disclaimer
  15.     IV  -  The Zipster Configuration File
  16.      V  -  Using Zipster with QuickBBS
  17.     VI  -  Using Zipster with other BBSes
  18.    VII  -  Trouble Shooting
  19.   VIII  -  Acknowledgements
  20.     IX  -  Reaching the Author
  21.  
  22.  
  23.   I. Files Needed
  24.  
  25.   Zipster should include the following four files:
  26.  
  27.     ZIPSTER.EXE - The Zipster door
  28.     ZIPSTER.DOC - This documentation file
  29.     ZIPSTER.CFG - The sample configuration file
  30.     ZIPSTER.NEW - The list of changes to Zipster
  31.  
  32.   Zipster is basically a BBS shell for Phil Katz's PKZIP.EXE and
  33.   PKUNZIP.EXE utilities. It was tested with version 1.02 of those
  34.   utilities, available as PKZ102.EXE on many bulletin board systems.
  35.   Zipster was tested with version 2.63 of QuickBBS, but should work
  36.   with most types of BBS software that create a DORINFO1.DEF file.
  37.  
  38.   Zipster requires a fossil driver, such as BNU 2.70 by David Nugent.
  39.   A fossil driver allows for greater compatibility with various
  40.   computer systems. QuickBBS also requires a fossil driver, so this
  41.   does not mean any added work for QuickBBS sysops.
  42.  
  43.  
  44.   II. Basic Features of Zipster
  45.  
  46.   Zipster allows the viewing of Zipfiles on QuickBBS systems, and also
  47.   allows the reading, testing, and extraction of files within Zipfiles.
  48.   Zipfiles almost always end in .ZIP, but Zipster can also handle
  49.   self-extracting Zipfiles that end in .EXE.
  50.  
  51.   Zipster will monitor a user's remaining time, whether carrier is
  52.   dropped, and whether the user waits too long to press a key. Do not
  53.   use a separate utility to monitor the carrier.
  54.  
  55.   When Zipster is run, it locates the file DORINFO1.DEF which is created
  56.   by QuickBBS. This file gives Zipster information such as the user's
  57.   remaining time, graphics capability, and security level.
  58.  
  59.   If the sysop wants more than one directory to be checked for
  60.   Zipfiles, Zipster will use a file called FLSEARCH.CTL (QuickBBS
  61.   sysops should already be familiar with this file) to determine the
  62.   directories in which to search. If the user does not have a high
  63.   enough security level for a given directory, then that directory
  64.   is not searched.
  65.  
  66.  
  67.   III. Disclaimer
  68.  
  69.   Zipster has been tested by the author and it appears to be safe.
  70.   However, only use this program if you agree not to hold the author
  71.   responsible for any damage that it may cause your system.
  72.  
  73.  
  74.   IV. The Zipster Configuration File
  75.  
  76.   The sysop must edit a configuration file called ZIPSTER.CFG in order
  77.   for Zipster to function.
  78.  
  79.   Here is a sample:
  80.  
  81.   C:\BBS\DORINFO1.DEF
  82.   The Teletech BBS
  83.   C:\UTILITY\PKZIP.EXE
  84.   C:\UTILITY\PKUNZIP.EXE
  85.   C:\BBS\WORK
  86.   C:\BBS\FILES\UPLOADS
  87.   250
  88.  
  89.   The file is 7 lines total, and breaks down into this:
  90.  
  91.   Line 1 - The path and name for DORINFO1.DEF.
  92.  
  93.            QuickBBS, OLEcom, XBBS, and some other BBSes create a file
  94.            called DORINFO1.DEF when a door is executed. The file is
  95.            placed in the main BBS directory.
  96.  
  97.   Line 2 - The name of your BBS.
  98.  
  99.   Line 3 - The path and name of your PKZIP utility.
  100.            (PKZIP can be named whatever you choose).
  101.  
  102.   Line 4 - The path and name of your PKUNZIP utility.
  103.            (PKUNZIP can also be named whatever you choose).
  104.  
  105.   Line 5 - An empty directory that Zipster can use as a work directory.
  106.  
  107.   Line 6 - The directory where EXTRACT.ZIP will be placed.
  108.  
  109.            EXTRACT.ZIP is the name of the Zipfile that extracted files
  110.            are placed in, so this line should specify a directory from
  111.            which files can be downloaded.
  112.  
  113.   Line 7 - The Maximum size for EXTRACT.ZIP.
  114.  
  115.            This prevents a user from creating huge extract files in an
  116.            attempt to decrease the number of their downloads. Also, it
  117.            prevents an evil hacker from trying to clog your system
  118.            with a 20 Meg Zipfile. I suggest you place 250 here, which
  119.            means the file cannot be added to once it reaches 250
  120.            kilobytes.
  121.  
  122.  
  123.   V. Using Zipster with QuickBBS
  124.  
  125.      A. The Preferred Method for QuickBBS
  126.  
  127.         If you want to have Zipster search more than one directory,
  128.         you will need to have QuickBBS's FLSEARCH.CTL set up, and
  129.         have it placed in the main BBS directory. The directions for
  130.         setting this up are in the QuickBBS documentation, and also
  131.         in the section below (Part VI).
  132.  
  133.         First, put ZIPSTER.EXE and ZIPSTER.CFG in the QuickBBS
  134.         directory.
  135.  
  136.         Next, create a QuickBBS Type 7 menu item, with this on the
  137.         Optional Data line:
  138.  
  139.         To search all directories    : ZIPSTER.EXE
  140.  
  141.         To search a single directory : ZIPSTER.EXE [Name of directory]
  142.                          For example : ZIPSTER.EXE C:\BBS\UPLOADS
  143.  
  144.         If no directory was specified, Zipster will use FLSEARCH.CTL to
  145.         search all the directories in which a user has high enough
  146.         security to view.
  147.  
  148.         If a directory was specified, then Zipster will only search that
  149.         directory. FLSEARCH.CTL will not be used in this case. The sysop
  150.         is able to set up his menus so that only a person with a high
  151.         enough security level for the directory is allowed to use the
  152.         door.
  153.  
  154.      B. The Not-Preferred Method for QuickBBS
  155.  
  156.         Zipster can also be called from a batch file, but will not load
  157.         as quickly. The advantage is that ZIPSTER.EXE and ZIPSTER.CFG do
  158.         not have to reside in the BBS directory. Here are two examples,
  159.         both of which assume ZIPSTER.EXE and ZIPSTER.CFG are in the
  160.         directory C:\ZIPVIEW:
  161.  
  162.           To use FLSEARCH.CTL to             To search a single
  163.           search directories:                directory:
  164.  
  165.           CD \ZIPVIEW                        CD \ZIPVIEW
  166.           ZIPSTER.EXE                        ZIPSTER.EXE C:\BBS\UPLOADS
  167.           CD \BBS                            CD \BBS
  168.           EXIT                               EXIT
  169.  
  170.         If the chosen batch file was called ZIPVIEW.BAT, this would be
  171.         the Optional Data line for a QuickBBS Type 7 menu item:
  172.  
  173.                       *C /C C:\ZIPVIEW\ZIPVIEW.BAT
  174.  
  175.  
  176.   VI. Using Zipster with other BBSes
  177.  
  178.   If you are using a type of Bulletin Board System that creates a file
  179.   called DORINFO1.DEF when it shells to DOS, then chances are it will
  180.   work with Zipster. OLEcom, XBBS, RBBS, and other BBSes create such a
  181.   file, and will probably work fine with Zipster (as long as it is a
  182.   single-node BBS). If your BBS does not use a fossil driver, then make
  183.   sure you load a fossil driver before running Zipster.
  184.  
  185.   If you want to have Zipster handle more than one directory, you will
  186.   need to create a file called FLSEARCH.CTL. This file tells Zipster
  187.   which directories to search for files in, and also whether or not a
  188.   user has a high enough security level for a given directory.
  189.   FLSEARCH.CTL should go in the directory where DORINFO1.DEF will be,
  190.   which is not necessarily the Zipster directory!
  191.  
  192.   Here is the structure of FLSEARCH.CTL:
  193.  
  194.   [Directory] [Security Level Needed] [Name of Directory]
  195.  
  196.   To give a real-world example:
  197.  
  198.   C:\BBS\FILES\GAMES 20 Games
  199.   C:\BBS\FILES\COMM 10 Communications
  200.   C:\BBS\FILES\UTIL 20 Utility_Files
  201.   C:\BBS\FILES\UPLOADS 10 Uploads
  202.  
  203.   Note: All that is needed by Zipster are the directories and security
  204.         levels. The directory descriptions were only shown because that
  205.         is the format as QuickBBS originated it.
  206.  
  207.   ZIPSTER.EXE and ZIPSTER.CFG must reside together in the same
  208.   directory.
  209.  
  210.   The first line of ZIPSTER.CFG specifies the name and location of
  211.   DORINFO1.DEF. If more than one directory is to be searched, then
  212.   create the FLSEARCH.CTL file and place it in the directory where
  213.   DORINFO1.DEF will be written by the BBS.
  214.  
  215.   The command lines for calling Zipster are as follows:
  216.  
  217.   To search all directories    : ZIPSTER.EXE
  218.  
  219.   To search a single directory : ZIPSTER.EXE [Name of directory]
  220.                    For example : ZIPSTER.EXE C:\BBS\UPLOADS
  221.  
  222.   If Zipster is called from a batch file, the batch file should switch
  223.   to the directory that has ZIPSTER.EXE, and then run Zipster.
  224.   For example:
  225.  
  226.      CD \ZIPVIEW
  227.      ZIPSTER.EXE
  228.      CD \BBS
  229.      EXIT
  230.  
  231.  
  232.   VII. Trouble Shooting
  233.  
  234.   If you run into problems, chances are the ZIPSTER.CFG or FLSEARCH.CTL
  235.   file was not created properly. So it's a good idea to double check
  236.   them.
  237.  
  238.   Another possible problem is insufficient memory. Zipster itself
  239.   requires about 40K, but PKZIP and PKUNZIP will add about 90K to this.
  240.   QuickBBS sysops who have insufficient memory to properly run Zipster
  241.   should use the overlay version of QuickBBS, or should experiment with
  242.   QuickBBS's Type 15 menu item. Type 15 removes the BBS from memory, so
  243.   it is a much slower method than Type 7.
  244.  
  245.   For the hang-up feature, Zipster toggles the DTR. If you try this
  246.   feature and it doesn't drop carrier on the caller, then you might
  247.   want to try adding &D2&C1 to your modem's initialization string.
  248.  
  249.   The jump to DOS feature and the main test Zipfile feature look at
  250.   COMSPEC for the location of COMMAND.COM. If you boot off of a floppy
  251.   drive, you might want to add this to the floppy's AUTOEXEC.BAT:
  252.  
  253.   SET COMSPEC=C:\COMMAND.COM
  254.  
  255.   That will speed things up a bit, and will also guard against the fact
  256.   that the boot floppy may no longer be in the floppy drive, or that
  257.   the floppy drive may be open.
  258.  
  259.   Zipster uses Bios screen writes, so its graphics should be compatible
  260.   with multi-taskers.
  261.  
  262.  
  263.   VIII. Acknowledgements
  264.  
  265.   Phil Katz, Loren Strand, Leif Manley, and Joshua Ellis gave me
  266.   financial contributions for Zipster, which went to support my BBS.
  267.   Thanks!
  268.  
  269.   I'd also like to thank everyone who has offered suggestions and
  270.   helped test various versions of Zipster.
  271.  
  272.   Much credit also goes to Adam Hudson and the QuickBBS Group for
  273.   writing QuickBBS, and Phil Katz for writing PKZIP and PKUNZIP.
  274.  
  275.  
  276.   IX. Reaching the Author
  277.  
  278.   If you run into any bugs or problems you cannot solve, I can be
  279.   reached either through my BBS or my home address:
  280.  
  281.          The Teletech BBS
  282.          (804)671-8755
  283.          1:271/306
  284.  
  285.          Bill Hay
  286.          5284 Fairfield Blvd.
  287.          Virginia Beach, VA 23464
  288.  
  289.   Although payment is not required for using Zipster, a contribution of
  290.   ten dollars would be appreciated. All proceeds go toward the upkeep of
  291.   my BBS.
  292.  
  293.   Thanks for trying Zipster!
  294.  
  295.